home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / SgDropPocket.z / SgDropPocket
Text File  |  1998-10-30  |  16KB  |  265 lines
  1.  
  2.  
  3.  
  4.      SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt - The DropPocket widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<SSSSggggmmmm////DDDDrrrrooooppppPPPPoooocccckkkkeeeetttt....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents the version of Sgm that accompanies
  17.           Motif 2.1.
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.           DropPocket is designed for receiving icons.  The user will
  21.           see the icon in the DropPocket as a visual reminder of the
  22.           type of the file associated with the DropPocket.  The user
  23.           may drop SGI file icons onto the dropPocket.  The DropPocket
  24.           will determine the name of the icon and return information
  25.           describing the icon to the application in the callback.
  26.  
  27.           The DropPocket background changes color when an droppable
  28.           icon is above the DropPocket. Once an icon has been dropped
  29.           on the DropPocket, the icon is displayed in the DropPocket.
  30.  
  31.         CCCCllllaaaasssssssseeeessss
  32.           DropPocket inherits behavior and resources from CCCCoooorrrreeee and
  33.           XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee Classes.
  34.  
  35.           The class pointer is ssssggggDDDDrrrrooooppppPPPPoooocccckkkkeeeettttWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  36.  
  37.           The class name is SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt.
  38.  
  39.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  40.           The following table defines a set of widget resources used
  41.           by the programmer to specify data.  The programmer can also
  42.           set the resource values for the inherited classes to set
  43.           attributes for this widget.  To reference a resource by name
  44.           or by class in a .Xdefaults file, remove the SSSSggggNNNN, SSSSggggCCCC, XXXXmmmmNNNN
  45.           or XXXXmmmmCCCC prefix and use the remaining letters.  To specify one
  46.           of the defined values for a resource in a .Xdefaults file,
  47.           remove the prefix and use the remaining letters (in either
  48.           lowercase or uppercase, but include any underscores between
  49.           words).  The codes in the access column indicate if the
  50.           given resource can be set at creation time (C), set by using
  51.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  52.           not applicable (N/A).
  53.  
  54.                                           SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  55.      NNNNaaaammmmeeee                  CCCCllllaaaassssssss                      TTTTyyyyppppeeee       DDDDeeeeffffaaaauuuulllltttt                           AAAAcccccccceeeessssssss
  56.      ____________________________________________________________________________________________________
  57.      SgNactivePixel        XmCDropPocketActivePixel   Pixel      blue                              CSG
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.      SgNiconDataBasePath   SgCIconDataBasePath        XmString   /usr/lib/filetype/workspace.ctr   CSG
  75.      SgNname               SgCNname                   XmString   NULL                              CSG
  76.  
  77.  
  78.           SSSSggggNNNNDDDDrrrrooooppppPPPPoooocccckkkkeeeettttAAAAccccttttiiiivvvveeeePPPPiiiixxxxeeeellll
  79.                     Specifies the color for the background of the
  80.                     DropPocket when a droppable icon is above the
  81.                     DropPocket.
  82.  
  83.           SSSSggggNNNNiiiiccccoooonnnnDDDDaaaattttaaaaBBBBaaaasssseeeePPPPaaaatttthhhh
  84.                     Specifies the location of the icon database.  The
  85.                     default value is /usr/lib/filetype/workspace.ctr.
  86.                     Setting this resource to a filename that is not a
  87.                     legal icon database will cause serious problems
  88.                     for the DropPocket.
  89.  
  90.           SSSSggggNNNNnnnnaaaammmmeeee   Specifies the compound string that is the name of
  91.                     the current icon.  By setting this resource, the
  92.                     application can control the initial icon that
  93.                     appears in the DropPocket.  If this resource is
  94.                     NULL, the DropPocket will appear empty. Refer to
  95.                     XXXXmmmmSSSSttttrrrriiiinnnngggg((((3333XXXX)))) for more information on the creation
  96.                     and structure of compound strings.
  97.  
  98.  
  99.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  100.           DropPocket inherits behavior and resources from the
  101.           following superclasses.  For a complete description of each
  102.           resource, refer to the man page for that superclass.
  103.  
  104.                                          XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  105.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  106.      ________________________________________________________________________________________________
  107.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic                CSG
  108.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap             XmUNSPECIFIED_PIXMAP   CSG
  109.      XmNforeground           XmCForeground           Pixel              dynamic                CSG
  110.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL                   C
  111.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic                CSG
  112.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False                  CSG
  113.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap             dynamic                CSG
  114.      XmNhighlightThickness   XmCHighlightThickness   Dimension          0                      CSG
  115.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE                 CSG
  116.      XmNshadowThickness      XmCShadowThickness      Dimension          0                      CSG
  117.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic                CSG
  118.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap             dynamic                CSG
  119.      XmNtraversalOn          XmCTraversalOn          Boolean            False                  CSG
  120.      XmNunitType             XmCUnitType             unsigned char      dynamic                CSG
  121.      XmNuserData             XmCUserData             XtPointer          NULL                   CSG
  122.  
  123.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))
  137.  
  138.  
  139.  
  140.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  141.      ______________________________________________________________________________________________________________
  142.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  143.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  144.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  145.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  146.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  147.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  148.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  149.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  150.      XmNdepth                        XmCDepth                        int              dynamic                CG
  151.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  152.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  153.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  154.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  155.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  156.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  157.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  158.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  159.      XmNx                            XmCPosition                     Position         0                      CSG
  160.      XmNy                            XmCPosition                     Position         0                      CSG
  161.  
  162.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  163.           The Callback structure is SgDropPocketCallbackStruct.  A
  164.           pointer to the following structure is passed to each
  165.           callback:
  166.  
  167.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  168.           {{{{
  169.             iiiinnnntttt      _r_e_a_s_o_n;;;;
  170.             XXXXEEEEvvvveeeennnntttt   * _e_v_e_n_t;;;;
  171.             WWWWiiiinnnnddddoooowwww   _w_i_n_d_o_w;;;;
  172.             XXXXmmmmSSSSttttrrrriiiinnnngggg _i_c_o_n_N_a_m_e;;;;
  173.             cccchhhhaaaarrrr ****   _i_c_o_n_D_a_t_a;;;;
  174.           }}}} SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeettttCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  175.  
  176.  
  177.           _r_e_a_s_o_n    Indicates why the callback was invoked.  The
  178.                     constant SSSSggggCCCCRRRR____IIIICCCCOOOONNNN____CCCCHHHHAAAANNNNGGGGEEEE is the reason associated
  179.                     with callbacks generated by a successful icon drop
  180.                     on the DropPocket.
  181.  
  182.           _e_v_e_n_t     Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback
  183.  
  184.           _w_i_n_d_o_w    Specifies the window of the DropPocket.
  185.  
  186.           _i_c_o_n_N_a_m_e  Specifies the name of the icon.  For icons
  187.                     representing files, this is the file name.  For
  188.                     other types of icons, the name may not completely
  189.                     specify the icon.  For example a person icon may
  190.                     have the name jake, but the icon represents a
  191.                     person in /usr/lib/faces/jake.
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))          UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV          SSSSggggDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           _i_c_o_n_D_a_t_a  The full string description of the icon.
  207.  
  208.  
  209.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  210.           SgDropPocket includes translations from Primitive.  The
  211.           SgDropPocket translations are listed below.  These
  212.           translations may not directly correspond to a translation
  213.           table.
  214.  
  215.           EEEEnnnntttteeeerrrr::::         EEEEnnnntttteeeerrrr(((())))
  216.           LLLLeeeeaaaavvvveeee::::         LLLLeeeeaaaavvvveeee(((())))
  217.  
  218.  
  219.         AAAAccccttttiiiioooonnnn RRRRoooouuuuttttiiiinnnneeeessss
  220.           The SgDropPocket action routines are described below:
  221.  
  222.  
  223.           EEEEnnnntttteeeerrrr(((()))):  When the pointer enters the DropPocket, this
  224.                     action highlights the icon and changes the
  225.                     background color if the pointer contains a
  226.                     droppable icon.
  227.  
  228.           LLLLeeeeaaaavvvveeee(((()))):  This unhighlights the icon and resets the
  229.                     background color when the pointer leaves the
  230.                     DropPocket.
  231.  
  232.  
  233.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  234.           The bindings for virtual keys are vendor specific.  For
  235.           information about bindings for virtual buttons and keys, see
  236.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
  237.  
  238.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  239.           CCCCoooorrrreeee((((3333XXXX)))), SSSSggggCCCCrrrreeeeaaaatttteeeeDDDDrrrrooooppppPPPPoooocccckkkkeeeetttt((((3333XXXX)))), and XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee((((3333XXXX)))).
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                         (printed 10/24/98)
  262.  
  263.  
  264.  
  265.